<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: ValidationContext.html 689 2013-06-28 19:22:16Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.validation;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.util.HashMap;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.util.HashSet;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.util.Set;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.util.concurrent.Callable;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>import javax.validation.ConstraintViolation;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import javax.validation.Validation;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import javax.validation.Validator;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.dellroad.stuff.java.ThreadLocalHolder;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>/**<a name="line.21"></a>
<span class="sourceLineNo">022</span> * Provides additional context for {@link javax.validation.ConstraintValidator} implementations.<a name="line.22"></a>
<span class="sourceLineNo">023</span> *<a name="line.23"></a>
<span class="sourceLineNo">024</span> * &lt;p&gt;<a name="line.24"></a>
<span class="sourceLineNo">025</span> * {@link ValidationContext} gives {@link javax.validation.ConstraintValidator} implementations access to the root object<a name="line.25"></a>
<span class="sourceLineNo">026</span> * being validated. This breaks the usual principle of locality for validation (i.e., that validation of a specific bean<a name="line.26"></a>
<span class="sourceLineNo">027</span> * proceeds unaware of that bean's parents) but it can make custom validators more convenient to implement.<a name="line.27"></a>
<span class="sourceLineNo">028</span> * Subclasses are encouraged to provide additional application-specific information.<a name="line.28"></a>
<span class="sourceLineNo">029</span> *<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;p&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> * Validation must be performed via {@link #validate(Validator) validate()} for this class to work.<a name="line.31"></a>
<span class="sourceLineNo">032</span> *<a name="line.32"></a>
<span class="sourceLineNo">033</span> * @param &lt;T&gt; type of the root object being validated<a name="line.33"></a>
<span class="sourceLineNo">034</span> */<a name="line.34"></a>
<span class="sourceLineNo">035</span>public class ValidationContext&lt;T&gt; {<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>    private static final ThreadLocalHolder&lt;ValidationContext&lt;?&gt;&gt; CURRENT = new ThreadLocalHolder&lt;ValidationContext&lt;?&gt;&gt;();<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span>    private final HashMap&lt;String, Set&lt;Object&gt;&gt; uniqueDomainMap = new HashMap&lt;String, Set&lt;Object&gt;&gt;();<a name="line.39"></a>
<span class="sourceLineNo">040</span>    private final T root;<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>    /**<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * Construct a new validation context configured to validate the given root object.<a name="line.43"></a>
<span class="sourceLineNo">044</span>     *<a name="line.44"></a>
<span class="sourceLineNo">045</span>     * @param root root object to be validated<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * @throws IllegalArgumentException if {@code root} is null<a name="line.46"></a>
<span class="sourceLineNo">047</span>     */<a name="line.47"></a>
<span class="sourceLineNo">048</span>    public ValidationContext(T root) {<a name="line.48"></a>
<span class="sourceLineNo">049</span>        if (root == null)<a name="line.49"></a>
<span class="sourceLineNo">050</span>            throw new IllegalArgumentException("null root");<a name="line.50"></a>
<span class="sourceLineNo">051</span>        this.root = root;<a name="line.51"></a>
<span class="sourceLineNo">052</span>    }<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>    /**<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * Get the root object associated with this instance.<a name="line.55"></a>
<span class="sourceLineNo">056</span>     */<a name="line.56"></a>
<span class="sourceLineNo">057</span>    public final T getRoot() {<a name="line.57"></a>
<span class="sourceLineNo">058</span>        return this.root;<a name="line.58"></a>
<span class="sourceLineNo">059</span>    }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span>    /**<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * Validate this instance's root object. This is a convenience method, equivalent to:<a name="line.62"></a>
<span class="sourceLineNo">063</span>     *  &lt;blockquote&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span>     *  &lt;code&gt;{@link #validate(Validator) validate}(Validation.buildDefaultValidatorFactory().getValidator())&lt;/code&gt;<a name="line.64"></a>
<span class="sourceLineNo">065</span>     *  &lt;blockquote&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span>     *<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * @throws IllegalStateException if this method is invoked re-entrantly<a name="line.67"></a>
<span class="sourceLineNo">068</span>     */<a name="line.68"></a>
<span class="sourceLineNo">069</span>    public Set&lt;ConstraintViolation&lt;T&gt;&gt; validate() {<a name="line.69"></a>
<span class="sourceLineNo">070</span>        return this.validate(Validation.buildDefaultValidatorFactory().getValidator());<a name="line.70"></a>
<span class="sourceLineNo">071</span>    }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span>    /**<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * Validate this instance's root object using the given {@link Validator}, making the context<a name="line.74"></a>
<span class="sourceLineNo">075</span>     * available to the current thread during the validation process via {@link #getCurrentContext}.<a name="line.75"></a>
<span class="sourceLineNo">076</span>     *<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * @throws IllegalStateException if this method is invoked re-entrantly<a name="line.77"></a>
<span class="sourceLineNo">078</span>     */<a name="line.78"></a>
<span class="sourceLineNo">079</span>    public Set&lt;ConstraintViolation&lt;T&gt;&gt; validate(final Validator validator) {<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span>        // Sanity check<a name="line.81"></a>
<span class="sourceLineNo">082</span>        if (ValidationContext.CURRENT.get() != null)<a name="line.82"></a>
<span class="sourceLineNo">083</span>            throw new IllegalStateException("re-entrant invocation is not allowed");<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span>        // Validate<a name="line.85"></a>
<span class="sourceLineNo">086</span>        try {<a name="line.86"></a>
<span class="sourceLineNo">087</span>            return ValidationContext.CURRENT.invoke(this, new Callable&lt;Set&lt;ConstraintViolation&lt;T&gt;&gt;&gt;() {<a name="line.87"></a>
<span class="sourceLineNo">088</span>                @Override<a name="line.88"></a>
<span class="sourceLineNo">089</span>                public Set&lt;ConstraintViolation&lt;T&gt;&gt; call() {<a name="line.89"></a>
<span class="sourceLineNo">090</span>                    return validator.validate(ValidationContext.this.root);<a name="line.90"></a>
<span class="sourceLineNo">091</span>                }<a name="line.91"></a>
<span class="sourceLineNo">092</span>            });<a name="line.92"></a>
<span class="sourceLineNo">093</span>        } catch (RuntimeException e) {<a name="line.93"></a>
<span class="sourceLineNo">094</span>            throw e;<a name="line.94"></a>
<span class="sourceLineNo">095</span>        } catch (Exception e) {<a name="line.95"></a>
<span class="sourceLineNo">096</span>            throw new RuntimeException(e);<a name="line.96"></a>
<span class="sourceLineNo">097</span>        }<a name="line.97"></a>
<span class="sourceLineNo">098</span>    }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span>    /**<a name="line.100"></a>
<span class="sourceLineNo">101</span>     * Get the {@link ValidationContext} associated with the current thread.<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * This method is only valid during invocations of {@link #validate(Validator) validate()}.<a name="line.102"></a>
<span class="sourceLineNo">103</span>     *<a name="line.103"></a>
<span class="sourceLineNo">104</span>     * @return current {@link ValidationContext}<a name="line.104"></a>
<span class="sourceLineNo">105</span>     * @throws IllegalStateException if {@link #validate(Validator) validate()} is not currently executing<a name="line.105"></a>
<span class="sourceLineNo">106</span>     */<a name="line.106"></a>
<span class="sourceLineNo">107</span>    public static ValidationContext&lt;?&gt; getCurrentContext() {<a name="line.107"></a>
<span class="sourceLineNo">108</span>        ValidationContext&lt;?&gt; context = ValidationContext.CURRENT.get();<a name="line.108"></a>
<span class="sourceLineNo">109</span>        if (context == null)<a name="line.109"></a>
<span class="sourceLineNo">110</span>            throw new IllegalStateException("current thread is not executing validate()");<a name="line.110"></a>
<span class="sourceLineNo">111</span>        return context;<a name="line.111"></a>
<span class="sourceLineNo">112</span>    }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span>    /**<a name="line.114"></a>
<span class="sourceLineNo">115</span>     * Get the {@link ValidationContext} associated with the current thread, cast to the desired type.<a name="line.115"></a>
<span class="sourceLineNo">116</span>     * This method is only valid during invocations of {@link #validate(Validator) validate()}.<a name="line.116"></a>
<span class="sourceLineNo">117</span>     *<a name="line.117"></a>
<span class="sourceLineNo">118</span>     * @param type required type<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * @return current {@link ValidationContext}<a name="line.119"></a>
<span class="sourceLineNo">120</span>     * @throws IllegalStateException if {@link #validate(Validator) validate()} is not currently executing<a name="line.120"></a>
<span class="sourceLineNo">121</span>     * @throws ClassCastException if the current {@link ValidationContext} is not of type {@code type}<a name="line.121"></a>
<span class="sourceLineNo">122</span>     * @throws NullPointerException if {@code type} is null<a name="line.122"></a>
<span class="sourceLineNo">123</span>     */<a name="line.123"></a>
<span class="sourceLineNo">124</span>    public static &lt;V extends ValidationContext&lt;?&gt;&gt; V getCurrentContext(Class&lt;V&gt; type) {<a name="line.124"></a>
<span class="sourceLineNo">125</span>        return type.cast(ValidationContext.getCurrentContext());<a name="line.125"></a>
<span class="sourceLineNo">126</span>    }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span>    /**<a name="line.128"></a>
<span class="sourceLineNo">129</span>     * Convenience method to get the root object being validated by the current thread.<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * This method is only valid during invocations of {@link #validate(Validator) validate()}.<a name="line.130"></a>
<span class="sourceLineNo">131</span>     *<a name="line.131"></a>
<span class="sourceLineNo">132</span>     * @return current validation root object<a name="line.132"></a>
<span class="sourceLineNo">133</span>     * @throws IllegalStateException if {@link #validate(Validator) validate()} is not currently executing<a name="line.133"></a>
<span class="sourceLineNo">134</span>     */<a name="line.134"></a>
<span class="sourceLineNo">135</span>    public static Object getCurrentRoot() {<a name="line.135"></a>
<span class="sourceLineNo">136</span>        return ValidationContext.getCurrentContext().getRoot();<a name="line.136"></a>
<span class="sourceLineNo">137</span>    }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span>    /**<a name="line.139"></a>
<span class="sourceLineNo">140</span>     * Convenience method to get the root object being validated by the current thread, cast to the desired type.<a name="line.140"></a>
<span class="sourceLineNo">141</span>     * This method is only valid during invocations of {@link #validate(Validator) validate()}.<a name="line.141"></a>
<span class="sourceLineNo">142</span>     *<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * @return current validation root object<a name="line.143"></a>
<span class="sourceLineNo">144</span>     * @throws IllegalStateException if {@link #validate(Validator) validate()} is not currently executing<a name="line.144"></a>
<span class="sourceLineNo">145</span>     * @throws ClassCastException if the current validation root is not of type {@code type}<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * @throws NullPointerException if {@code type} is null<a name="line.146"></a>
<span class="sourceLineNo">147</span>     */<a name="line.147"></a>
<span class="sourceLineNo">148</span>    public static &lt;T&gt; T getCurrentRoot(Class&lt;T&gt; type) {<a name="line.148"></a>
<span class="sourceLineNo">149</span>        return type.cast(ValidationContext.getCurrentRoot());<a name="line.149"></a>
<span class="sourceLineNo">150</span>    }<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span>    /**<a name="line.152"></a>
<span class="sourceLineNo">153</span>     * Get the uniqueness domain with the given name. Used to validate {@link Unique @Unique} constraints.<a name="line.153"></a>
<span class="sourceLineNo">154</span>     *<a name="line.154"></a>
<span class="sourceLineNo">155</span>     * @param domain name of the uniqueness domain<a name="line.155"></a>
<span class="sourceLineNo">156</span>     * @return set containing the unique values that have already been seen during this validation check<a name="line.156"></a>
<span class="sourceLineNo">157</span>     */<a name="line.157"></a>
<span class="sourceLineNo">158</span>    public Set&lt;Object&gt; getUniqueDomain(String domain) {<a name="line.158"></a>
<span class="sourceLineNo">159</span>        Set&lt;Object&gt; uniqueDomain = this.uniqueDomainMap.get(domain);<a name="line.159"></a>
<span class="sourceLineNo">160</span>        if (uniqueDomain == null) {<a name="line.160"></a>
<span class="sourceLineNo">161</span>            uniqueDomain = new HashSet&lt;Object&gt;();<a name="line.161"></a>
<span class="sourceLineNo">162</span>            this.uniqueDomainMap.put(domain, uniqueDomain);<a name="line.162"></a>
<span class="sourceLineNo">163</span>        }<a name="line.163"></a>
<span class="sourceLineNo">164</span>        return uniqueDomain;<a name="line.164"></a>
<span class="sourceLineNo">165</span>    }<a name="line.165"></a>
<span class="sourceLineNo">166</span>}<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>




























































</pre>
</div>
</body>
</html>
